<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: elftosb::OptionDictionary Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader Host
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Host Tools for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classelftosb_1_1_option_dictionary.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classelftosb_1_1_option_dictionary-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">elftosb::OptionDictionary Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Concrete implementation of <a class="el" href="classelftosb_1_1_option_context.html" title="Pure abstract interface class to a table of options. ">OptionContext</a>.  
 <a href="classelftosb_1_1_option_dictionary.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_option_dictionary_8h_source.html">OptionDictionary.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for elftosb::OptionDictionary:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classelftosb_1_1_option_dictionary__inherit__graph.svg" width="198" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for elftosb::OptionDictionary:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classelftosb_1_1_option_dictionary__coll__graph.svg" width="388" height="350"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structelftosb_1_1_option_dictionary_1_1_option_value.html">OptionValue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Information about one option's value.  <a href="structelftosb_1_1_option_dictionary_1_1_option_value.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae1219d9d52c600c05abce9f5f64dbecf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1219d9d52c600c05abce9f5f64dbecf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#ae1219d9d52c600c05abce9f5f64dbecf">OptionDictionary</a> ()</td></tr>
<tr class="memdesc:ae1219d9d52c600c05abce9f5f64dbecf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:ae1219d9d52c600c05abce9f5f64dbecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3f7a6ea3c5bdea61042913077bd9a0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3f7a6ea3c5bdea61042913077bd9a0c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#ae3f7a6ea3c5bdea61042913077bd9a0c">OptionDictionary</a> (<a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *parent)</td></tr>
<tr class="memdesc:ae3f7a6ea3c5bdea61042913077bd9a0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor taking a parent context. <br /></td></tr>
<tr class="separator:ae3f7a6ea3c5bdea61042913077bd9a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac6d0e558de6fac55462b9a62ecc62e3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#aac6d0e558de6fac55462b9a62ecc62e3">~OptionDictionary</a> ()</td></tr>
<tr class="memdesc:aac6d0e558de6fac55462b9a62ecc62e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aac6d0e558de6fac55462b9a62ecc62e3">More...</a><br /></td></tr>
<tr class="separator:aac6d0e558de6fac55462b9a62ecc62e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Parents</div></td></tr>
<tr class="memitem:af47e367c191f5f72e6348b024ae073a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#af47e367c191f5f72e6348b024ae073a1">getParent</a> () const </td></tr>
<tr class="memdesc:af47e367c191f5f72e6348b024ae073a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current parent context.  <a href="#af47e367c191f5f72e6348b024ae073a1">More...</a><br /></td></tr>
<tr class="separator:af47e367c191f5f72e6348b024ae073a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0b1f68d82d0450d96ab9f5f2cef41a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#ac0b1f68d82d0450d96ab9f5f2cef41a2">setParent</a> (<a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *newParent)</td></tr>
<tr class="memdesc:ac0b1f68d82d0450d96ab9f5f2cef41a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the parent context.  <a href="#ac0b1f68d82d0450d96ab9f5f2cef41a2">More...</a><br /></td></tr>
<tr class="separator:ac0b1f68d82d0450d96ab9f5f2cef41a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Options</div></td></tr>
<tr class="memitem:a06eecc97dde1bdf31d47a3f0f21371d5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a06eecc97dde1bdf31d47a3f0f21371d5">hasOption</a> (const std::string &amp;name) const </td></tr>
<tr class="memdesc:a06eecc97dde1bdf31d47a3f0f21371d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detemine whether the named option is present in the table.  <a href="#a06eecc97dde1bdf31d47a3f0f21371d5">More...</a><br /></td></tr>
<tr class="separator:a06eecc97dde1bdf31d47a3f0f21371d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8420e8239de77c045a52d2725f77541a"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classelftosb_1_1_value.html">Value</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a8420e8239de77c045a52d2725f77541a">getOption</a> (const std::string &amp;name) const </td></tr>
<tr class="memdesc:a8420e8239de77c045a52d2725f77541a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the option's value.  <a href="#a8420e8239de77c045a52d2725f77541a">More...</a><br /></td></tr>
<tr class="separator:a8420e8239de77c045a52d2725f77541a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a854d1a5cc670b0d1d747d73f82d0b8bd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a854d1a5cc670b0d1d747d73f82d0b8bd">setOption</a> (const std::string &amp;name, <a class="el" href="classelftosb_1_1_value.html">Value</a> *value)</td></tr>
<tr class="memdesc:a854d1a5cc670b0d1d747d73f82d0b8bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds or changes an option's value.  <a href="#a854d1a5cc670b0d1d747d73f82d0b8bd">More...</a><br /></td></tr>
<tr class="separator:a854d1a5cc670b0d1d747d73f82d0b8bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5db75b348e96c3cf920e6615edf9dabe"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a5db75b348e96c3cf920e6615edf9dabe">deleteOption</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:a5db75b348e96c3cf920e6615edf9dabe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an option from the table.  <a href="#a5db75b348e96c3cf920e6615edf9dabe">More...</a><br /></td></tr>
<tr class="separator:a5db75b348e96c3cf920e6615edf9dabe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Locking</div></td></tr>
<tr class="memitem:a48deaa5ec36f70b02c37b536dfd30874"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a48deaa5ec36f70b02c37b536dfd30874">isOptionLocked</a> (const std::string &amp;name) const </td></tr>
<tr class="memdesc:a48deaa5ec36f70b02c37b536dfd30874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the specified option is locked from further changes.  <a href="#a48deaa5ec36f70b02c37b536dfd30874">More...</a><br /></td></tr>
<tr class="separator:a48deaa5ec36f70b02c37b536dfd30874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae462adb3e381c4782340f0518c816d34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#ae462adb3e381c4782340f0518c816d34">lockOption</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:ae462adb3e381c4782340f0518c816d34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent further modifications of an option's value.  <a href="#ae462adb3e381c4782340f0518c816d34">More...</a><br /></td></tr>
<tr class="separator:ae462adb3e381c4782340f0518c816d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dd616bcebbcdb8012526a73e398f5e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a1dd616bcebbcdb8012526a73e398f5e3">unlockOption</a> (const std::string &amp;name)</td></tr>
<tr class="memdesc:a1dd616bcebbcdb8012526a73e398f5e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow an option to be changed.  <a href="#a1dd616bcebbcdb8012526a73e398f5e3">More...</a><br /></td></tr>
<tr class="separator:a1dd616bcebbcdb8012526a73e398f5e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Operators</div></td></tr>
<tr class="memitem:ae84a6d87145513cec9065f5a63626f9f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classelftosb_1_1_value.html">Value</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#ae84a6d87145513cec9065f5a63626f9f">operator[]</a> (const std::string &amp;name) const </td></tr>
<tr class="memdesc:ae84a6d87145513cec9065f5a63626f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indexing operator; returns the value for the option <em>name</em>.  <a href="#ae84a6d87145513cec9065f5a63626f9f">More...</a><br /></td></tr>
<tr class="separator:ae84a6d87145513cec9065f5a63626f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classelftosb_1_1_option_context"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classelftosb_1_1_option_context')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classelftosb_1_1_option_context.html">elftosb::OptionContext</a></td></tr>
<tr class="memitem:a5d00c2591de414fc455048f2938f831e inherit pub_methods_classelftosb_1_1_option_context"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d00c2591de414fc455048f2938f831e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_context.html#a5d00c2591de414fc455048f2938f831e">~OptionContext</a> ()</td></tr>
<tr class="memdesc:a5d00c2591de414fc455048f2938f831e inherit pub_methods_classelftosb_1_1_option_context"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the dtor virtual. <br /></td></tr>
<tr class="separator:a5d00c2591de414fc455048f2938f831e inherit pub_methods_classelftosb_1_1_option_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:aa3cf693f333d6a9f3095c6c7f0e8146b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3cf693f333d6a9f3095c6c7f0e8146b"></a>
typedef std::map&lt; std::string, <a class="el" href="structelftosb_1_1_option_dictionary_1_1_option_value.html">OptionValue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#aa3cf693f333d6a9f3095c6c7f0e8146b">option_map_t</a></td></tr>
<tr class="memdesc:aa3cf693f333d6a9f3095c6c7f0e8146b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map from option name to value. <br /></td></tr>
<tr class="separator:aa3cf693f333d6a9f3095c6c7f0e8146b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:abc179e5aabf72f043768b5c012ba0750"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc179e5aabf72f043768b5c012ba0750"></a>
<a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#abc179e5aabf72f043768b5c012ba0750">m_parent</a></td></tr>
<tr class="memdesc:abc179e5aabf72f043768b5c012ba0750"><td class="mdescLeft">&#160;</td><td class="mdescRight">Our parent context. <br /></td></tr>
<tr class="separator:abc179e5aabf72f043768b5c012ba0750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11b3bf9dd6be7bd9927cf52d15147ca2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11b3bf9dd6be7bd9927cf52d15147ca2"></a>
<a class="el" href="classelftosb_1_1_option_dictionary.html#aa3cf693f333d6a9f3095c6c7f0e8146b">option_map_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_option_dictionary.html#a11b3bf9dd6be7bd9927cf52d15147ca2">m_options</a></td></tr>
<tr class="memdesc:a11b3bf9dd6be7bd9927cf52d15147ca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The option dictionary. <br /></td></tr>
<tr class="separator:a11b3bf9dd6be7bd9927cf52d15147ca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Concrete implementation of <a class="el" href="classelftosb_1_1_option_context.html" title="Pure abstract interface class to a table of options. ">OptionContext</a>. </p>
<p>This context subclass supports having a parent context. If an option is not found in the receiving instance, the request is passed to the parent. The <a class="el" href="classelftosb_1_1_option_dictionary.html#a06eecc97dde1bdf31d47a3f0f21371d5" title="Detemine whether the named option is present in the table. ">hasOption()</a> and <a class="el" href="classelftosb_1_1_option_dictionary.html#a8420e8239de77c045a52d2725f77541a" title="Returns the option&#39;s value. ">getOption()</a> methods will ask up the parent chain if the requested option does not exist in the receiving instance. But the <a class="el" href="classelftosb_1_1_option_dictionary.html#a854d1a5cc670b0d1d747d73f82d0b8bd" title="Adds or changes an option&#39;s value. ">setOption()</a> and <a class="el" href="classelftosb_1_1_option_dictionary.html#a5db75b348e96c3cf920e6615edf9dabe" title="Removes an option from the table. ">deleteOption()</a> methods only operate locally, on the instance on which they were called. This allows a caller to locally override an option value without affecting any of the parent contexts. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aac6d0e558de6fac55462b9a62ecc62e3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OptionDictionary::~OptionDictionary </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>Deletes all of the option values that have been assigned locally. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5db75b348e96c3cf920e6615edf9dabe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void OptionDictionary::deleteOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Removes an option from the table. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the option to remove. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classelftosb_1_1_option_context.html#a857c8b33dda03bd4b53e5527446f50f6">elftosb::OptionContext</a>.</p>

</div>
</div>
<a class="anchor" id="a8420e8239de77c045a52d2725f77541a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classelftosb_1_1_value.html">Value</a> * OptionDictionary::getOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the option's value. </p>
<p>If this object does not contain an option with the name of <em>name</em>, then the parent is asked for the value (if a parent has been set).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the option. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value for the option named <em>name</em>. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">NULL</td><td>No option is in the table with that name. An option may also explicitly be set to a NULL value. The only way to tell the difference is to use the <a class="el" href="classelftosb_1_1_option_dictionary.html#a06eecc97dde1bdf31d47a3f0f21371d5" title="Detemine whether the named option is present in the table. ">hasOption()</a> method. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classelftosb_1_1_option_context.html#aff659da41d49788cc5e1d4047bd672bd">elftosb::OptionContext</a>.</p>

</div>
</div>
<a class="anchor" id="af47e367c191f5f72e6348b024ae073a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a>* elftosb::OptionDictionary::getParent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the current parent context. </p>
<dl class="section return"><dt>Returns</dt><dd>The current parent context instance. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">NULL</td><td>No parent has been set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a06eecc97dde1bdf31d47a3f0f21371d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool OptionDictionary::hasOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Detemine whether the named option is present in the table. </p>
<p>If a parent context has been set and the option does not exist in this instance, then the parent is asked if it contains the option.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the option to query. </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>The option is present in this instance or one of the parent. </td></tr>
    <tr><td class="paramname">false</td><td>No option with that name is in the dictionary, or any parent </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classelftosb_1_1_option_context.html#a469ea9d9205d041830ea14f618845f5f">elftosb::OptionContext</a>.</p>

</div>
</div>
<a class="anchor" id="a48deaa5ec36f70b02c37b536dfd30874"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool OptionDictionary::isOptionLocked </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns true if the specified option is locked from further changes. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the option to query.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the option is locked, false if unlocked or not present. </dd></dl>

</div>
</div>
<a class="anchor" id="ae462adb3e381c4782340f0518c816d34"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OptionDictionary::lockOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent further modifications of an option's value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the option to lock. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae84a6d87145513cec9065f5a63626f9f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classelftosb_1_1_value.html">Value</a> * OptionDictionary::operator[] </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indexing operator; returns the value for the option <em>name</em>. </p>
<p>Simply calls <a class="el" href="classelftosb_1_1_option_dictionary.html#a8420e8239de77c045a52d2725f77541a" title="Returns the option&#39;s value. ">getOption()</a>. </p>

</div>
</div>
<a class="anchor" id="a854d1a5cc670b0d1d747d73f82d0b8bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void OptionDictionary::setOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classelftosb_1_1_value.html">Value</a> *&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds or changes an option's value. </p>
<p>If the option was not already present in the table, it is added. Otherwise the old value is replaced. The option is always set locally; parent objects are never modified.</p>
<p>If the option has been locked with a call to <a class="el" href="classelftosb_1_1_option_dictionary.html#ae462adb3e381c4782340f0518c816d34" title="Prevent further modifications of an option&#39;s value. ">lockOption()</a> before trying to set its value, the <a class="el" href="classelftosb_1_1_option_dictionary.html#a854d1a5cc670b0d1d747d73f82d0b8bd" title="Adds or changes an option&#39;s value. ">setOption()</a> is effectively ignored. To tell if an option is locked, use the <a class="el" href="classelftosb_1_1_option_dictionary.html#a48deaa5ec36f70b02c37b536dfd30874" title="Returns true if the specified option is locked from further changes. ">isOptionLocked()</a> method.</p>
<dl class="section warning"><dt>Warning</dt><dd>If the option already had a value, that previous value is deleted. This means that it cannot currently be in use by another piece of code. See the note in <a class="el" href="classelftosb_1_1_option_dictionary.html#a8420e8239de77c045a52d2725f77541a" title="Returns the option&#39;s value. ">getOption()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The option's name. </td></tr>
    <tr><td class="paramname">value</td><td>New value for the option. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classelftosb_1_1_option_context.html#a559af695c2ca057929cb6c851eae9251">elftosb::OptionContext</a>.</p>

</div>
</div>
<a class="anchor" id="ac0b1f68d82d0450d96ab9f5f2cef41a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void elftosb::OptionDictionary::setParent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *&#160;</td>
          <td class="paramname"><em>newParent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Change the parent context. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">newParent</td><td>The parent context object. May be NULL, in which case the object will no longer have a parent context. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1dd616bcebbcdb8012526a73e398f5e3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OptionDictionary::unlockOption </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allow an option to be changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the option to unlock. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_option_dictionary_8h_source.html">OptionDictionary.h</a></li>
<li>OptionDictionary.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>elftosb</b></li><li class="navelem"><a class="el" href="classelftosb_1_1_option_dictionary.html">OptionDictionary</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:49:52 for Kinetis Bootloader Host by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
